FormulaFieldDefinition Object

Sample Code - FormulaFieldDefinition Object

The FormulaFieldDefinition Object provides properties and methods for retrieving information and setting options for any formula field found in a report.

FormulaFieldDefinition Properties

Property Description Read/Write

Application

Returns a reference to the Application Object, that this object is associated with.

Read only

FormulaField
Name

Returns the formula field name as it appears in the Formula Field list on the Formula Tab of the Insert Fields dialog box (for example, NewExampleFormula).

Read only

Kind

Returns CRFieldKind (see table below), which specifies what "kind" of field (that is, database, summary, formula, etc.).

Read only


Constant Value


crDatabaseField

1


crFormulaField

2


crGroupNameField

5


crParameterField

6


crSpecialVarField

4


crSummaryField

3

Property Description Read/Write

Name

Returns the name of the formula field as it would be displayed (referenced) in the report (that is, {@NewExampleFormula}).

Read only

NumberOfBytes

Returns the number of bytes required to store the field data in memory.

Read only

Parent

Reference to the Parent object (Report Object).

Read only

Report

Reference to Report Object.

Read only

Text

Returns/Sets the text of the formula. The formula text is changed immediately in the report. With that in mind, you should check the validity of the formula immediately after setting the Text property. Use Check Method (FormulaFieldDefinition Object), to check formulas. If you generate a report with an invalid formula, you may receive and exception error.

Read/Write

ValueType

Returns CRFieldValueType (see table below), which specifies the "type" of value found in the field.

Read only


Constant Value


crBitmapField

17


crBlobField

15


crBooleanField

9


crChartField

21


crCurrencyField

8


crDateField

10


crDateTimeField

16


crIconField

18


crInt16sField

3


crInt16uField

4


crInt32sField

5


crInt32uField

6


crInt8sField

1


crInt8uField

2


crNumberField

7


crOleField

20


crPersistentMemoField

14


crPictureField

19


crStringField

12


crTimeField

11


crTransientMemoField

13


crUnknownField

22



Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com